package com.ibm.util;

/**
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * A generic class for pairs.
 * 
 * @param <T1>
 * @param <T2>
 */
@SuppressWarnings("rawtypes")
public class ComparablePair<T1 extends Comparable, T2 extends Comparable>
		extends Pair<T1, T2> implements Comparable<ComparablePair<T1, T2>> {
	private static final long serialVersionUID = -2487131767936257690L;

	public ComparablePair(T1 a, T2 b) {
		super(a, b);
	}

	/**
	 * Constructs a new pair, inferring the type via the passed arguments
	 * 
	 * @param <T1>
	 *            type for first
	 * @param <T2>
	 *            type for second
	 * @param a
	 *            first element
	 * @param b
	 *            second element
	 * @return a new pair containing the passed arguments
	 */
	public static <T1 extends Comparable<T1>, T2 extends Comparable<T2>> Pair<T1, T2> newPair(
			T1 a, T2 b) {
		return new ComparablePair<T1, T2>(a, b);
	}

	@SuppressWarnings("unchecked")
	@Override
	public int compareTo(ComparablePair<T1, T2> o) {
		int ret = this.getFirst().compareTo(o.getFirst());
		if (ret != 0)
			return ret;
		return this.getSecond().compareTo(o.getSecond());
	}
}
